SixBit API Schema
SixBitAPICalls Element
Description
A collection of calls to the SixBit API.
Namespace (none)
Diagram
Sale_Update Element Sale_Add Element Sale_List Element Shipment_Update Element Shipment_Add Element Shipment_List Element Order_Update Element Order_Add Element Order_List Element Item_AddUpdate Element Item_List Element CompatibilitySets_AddUpdate Element CompatibilitySets_List Element Inventory_List Element Inventory_Set Element Inventory_Shrink Element Inventory_Remove Element Inventory_ReconcileTo Element Inventory_Add Element Supplier_AddUpdate Element Supplier_List Element Buyer_AddUpdate Element Buyer_List Element Choice Sequence SixBitAPICalls Element
Overview
SixBitAPICalls
A collection of calls to the SixBit API.
Sequence 0..∞
Choice
Buyer_List 0..∞ Buyer_ListType Complex Type
An API call to retrieve a list of buyers.
mapfilepath optional xs:string
The full name and path to a SixBit map file.
outputfilepath optional xs:string
The full name and path to a file to place the resulting output.
modifiedattrGroup
Attributes to specify a range of dates an object was modified.
buyerid optional xs:string
The unique Buyer ID.
buyeremail optional xs:string
The buyers email address.
pagingattrGroup
Attributes to provide paging capabilities.
Buyer_AddUpdate 0..∞ Buyer_AddUpdateType Complex Type
An API call to add or update buyers.
action optional auactionParam Simple Type
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Sequence
Buyer 0..∞ BuyerType Complex Type
The information about a buyer.
All
Sequence
Any 0..∞
Supplier_List 0..∞ Supplier_ListType Complex Type
An API call to retrieve a list of suppliers.
mapfilepath optional xs:string
The full name and path to a SixBit mapfile.
outputfilepath optional xs:string
The full name and path to a file to place the resulting output.
supplierid optional xs:string
The unique supplier id.
acctnumber optional xs:string
The suppliers account number.
isconsignor optional xs:boolean
This flag indicates the supplier is a consignor.
modifiedattrGroup
Attributes to specify a range of dates an object was modified.
pagingattrGroup
Attributes to provide paging capabilities.
Supplier_AddUpdate 0..∞ Supplier_AddUpdateType Complex Type
An API call to add or update suppliers.
action optional auactionParam Simple Type
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Sequence
Supplier 0..∞ SupplierType Complex Type
The information about a supplier.
All
Sequence
Any 0..∞
Inventory_Add 0..∞ Inventory_AddType Complex Type
An API call to add inventory to an item.
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Inventory_ReconcileTo 0..∞ Inventory_ReconcileToType Complex Type
An API call to reconcile an items inventory.
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Inventory_Remove 0..∞ Inventory_RemoveType Complex Type
An API call to remove inventory from an item.
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Inventory_Shrink 0..∞ Inventory_ShrinkType Complex Type
An API call to shrink inventory for an item.
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Inventory_Set 0..∞ Inventory_SetType Complex Type
An API call to set inventory for an item.
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Inventory_List 0..∞ Inventory_ListType Complex Type
An API call to retrieve a list of inventory.
mapfilepath optional xs:string
The full name and path to a SixBit mapfile.
outputfilepath optional xs:string
The full name and path to a file to place the resulting output.
purchasedattrGroup
Attributes to specify a range of dates an object was purchased.
itemid optional xs:string
The unique itemid.
externalitemid optional xs:string
The externally generated, unique identifier of the item.
sku optional xs:string
The unique SKU.
productid optional xs:string
The product id.
pagingattrGroup
Attributes to provide paging capabilities.
CompatibilitySets_List 0..∞ CompatibilitySet_ListType Complex Type
An API call to retrieve a list of compatibility sets.
mapfilepath optional xs:string
The full name and path to a SixBit map file.
outputfilepath optional xs:string
The full name and path to a file to place the resulting output.
compatibilitysetid optional xs:integer
The unique compatibility set ID.
compatibilitysetname optional xs:string
The name of the compatibility set.
pagingattrGroup
Attributes to provide paging capabilities.
CompatibilitySets_AddUpdate 0..∞ CompatibilitySet_AddUpdateType Complex Type
An API call to add or update compatibility sets.
Item_List 0..∞ Item_ListType Complex Type
An API call to retrieve a list of items.
mapfilepath optional xs:string
The full name and path to a SixBit map file.
outputfilepath optional xs:string
The full name and path to a file to place the resulting output.
itemid optional xs:string
The unique Item ID.
externalitemid optional xs:string
The externally generated, unique identifier of the item.
sku optional xs:string
The Stock Keeping Unit identifier.
productid optional xs:string
The product id.
createdattrGroup
Attributes to specify a range of dates an object was created.
listedattrGroup
Attributes to specify a range of dates an item was listed.
pagingattrGroup
Attributes to provide paging capabilities.
Item_AddUpdate 0..∞ Item_AddUpdateType Complex Type
An API call to add or update items.
action optional auactionParam Simple Type
importurlsaslinks optional xs:boolean
This flag indicates that URL's should be imported as links instead of pictures.
replaceexistingpictures optional xs:boolean
This flag indicates that the incoming pictures should replace the existing pictures instead of appending.
updaterunninglistings optional xs:boolean
This flag indicates that any running listings associated with the imported items should be updated.
logfilepath optional xs:string
The full name and path to a location to place logging information.
itemtemplate optional xs:string
The name of the desired Item Template to base the import off of.
All
Sequence
Item 0..∞ ItemType Complex Type
The information about an item.
All
basedOn optional xs:string
The site whose specifics this variation will be based.
ebayEnabled optional xs:boolean
Whether or not this variation set can be used on eBay.
etsyEnabled optional xs:boolean
Whether or not this variation set can be used on Etsy.
amazonEnabled optional xs:boolean
Whether or not this variation set can be used on Amazon.
shopifyEnabled optional xs:boolean
Whether or not this variation set can be used on Shopify.
pictureVariation optional Restriction of xs:integer
Optional - Defaults to 1. Which variation value is the basis for the variation pictures on this item?
Sequence 1..∞
Variation VariationType Complex Type
The information about a variation.
All
Sequence
Picture 0..∞ PictureType Complex Type
The information about a picture.
Sequence
All
Sequence
SelectedValues optional SelectedValuesType Complex Type
A collection of selectedvalue elements.
All
Sequence
Any 0..∞
Order_List 0..∞ Order_ListType Complex Type
An API call to retrieve a list of orders.
mapfilepath optional xs:string
The full name and path to a SixBit mapfile.
outputfilepath optional xs:string
The full name and path to a file to place the resulting output.
orderidattrGroup
Attributes to specify the internal or external identifier for an order.
createdattrGroup
Attributes to specify a range of dates an object was created.
fulfilledattrGroup
Attributes to specify a range of dates an order was fulfilled.
invoicedattrGroup
Attributes to specify a range of dates an order was invoiced.
paymentclearedattrGroup
Attributes to specify a range of dates payment cleared on an order.
paymentreceivedattrGroup
Attributes to specify a range of dates payment was received on an order.
pagingattrGroup
Attributes to provide paging capabilities.
Order_Add 0..∞ Order_AddUpdateType Complex Type
An API call to add orders.
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Sequence
Order 0..∞ OrderType Complex Type
The information about an order.
All
All
Sequence
Any 0..∞
Sequence
Any 0..∞
Shipments optional
Sequence
All
Sales optional
Order_Update 0..∞ Order_AddUpdateType Complex Type
An API call to update orders.
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Sequence
Order 0..∞ OrderType Complex Type
The information about an order.
All
All
Sequence
Any 0..∞
Sequence
Any 0..∞
Shipments optional
Sequence
All
Sales optional
Shipment_List 0..∞ Shipment_ListType Complex Type
An API call to retrieve a list of shipments.
mapfilepath optional xs:string
The full name and path to a SixBit mapfile.
outputfilepath optional xs:string
The full name and path to a file to place the resulting output.
shipmentidattrGroup
Attributes to specify the internal or external identifier for a shipment.
orderidattrGroup
Attributes to specify the internal or external identifier for an order.
dropshippernotifiedattrGroup
Attributes to specify a range of dates the drop shipper was notified about a shipment.
insuredattrGroup
Attributes to specify a range of dates a shipment was insured.
shippedattrGroup
Attributes to specify a range of dates a shipment was shipped.
shippednotificationattrGroup
Attributes to specify a range of dates the the buyer was notified about a shipment.
pagingattrGroup
Attributes to provide paging capabilities.
Shipment_Add 0..∞ Shipment_AddUpdateType Complex Type
An API call to add shipments.
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Sequence
Shipment 0..∞ ShipmentType Complex Type
The information about a shipment.
All
Sequence
Any 0..∞
Sales optional
Sequence
Sale 1..∞ SaleType Complex Type
The information about a sale.
All
Shipment_Update 0..∞ Shipment_AddUpdateType Complex Type
An API call to update shipments.
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Sequence
Shipment 0..∞ ShipmentType Complex Type
The information about a shipment.
All
Sequence
Any 0..∞
Sales optional
Sequence
Sale 1..∞ SaleType Complex Type
The information about a sale.
All
Sale_List 0..∞ Sale_ListType Complex Type
An API call to retrieve a list of sales.
mapfilepath optional xs:string
The full name and path to a SixBit mapfile.
outputfilepath optional xs:string
The full name and path to a file to place the resulting output.
saleid optional xs:string
The unique saleid.
transactionid optional xs:string
The unique transactionid.
shipmentidattrGroup
Attributes to specify the internal or external identifier for a shipment.
orderidattrGroup
Attributes to specify the internal or external identifier for an order.
consignornotifiedattrGroup
Attributes to specify a range of dates the consignor was notified about a sale.
consignorpaidattrGroup
Attributes to specify a range of dates the consignor was paid for a sale.
saledateattrGroup
Attributes to specify a range of dates a sale occurred.
pagingattrGroup
Attributes to provide paging capabilities.
Sale_Add 0..∞ Sale_AddUpdateType Complex Type
An API call to add sales.
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Sequence
Sale 0..∞ SaleType Complex Type
The information about a sale.
All
Sequence
Any 0..∞
Sale_Update 0..∞ Sale_AddUpdateType Complex Type
An API call to update sales.
logfilepath optional xs:string
The full name and path to a location to place logging information.
All
Sequence
Sale 0..∞ SaleType Complex Type
The information about a sale.
All
Sequence
Any 0..∞
Source
<xs:element name="SixBitAPICalls" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>A collection of calls to the SixBit API.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence maxOccurs="unbounded" minOccurs="0">
      <xs:choice>
        <xs:element name="Buyer_List" type="Buyer_ListType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to retrieve a list of buyers.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Buyer_AddUpdate" type="Buyer_AddUpdateType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to add or update buyers.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Supplier_List" type="Supplier_ListType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to retrieve a list of suppliers.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Supplier_AddUpdate" type="Supplier_AddUpdateType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to add or update suppliers.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Inventory_Add" type="Inventory_AddType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to add inventory to an item.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Inventory_ReconcileTo" type="Inventory_ReconcileToType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to reconcile an items inventory.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Inventory_Remove" type="Inventory_RemoveType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to remove inventory from an item.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Inventory_Shrink" type="Inventory_ShrinkType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to shrink inventory for an item.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Inventory_Set" type="Inventory_SetType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to set inventory for an item.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Inventory_List" type="Inventory_ListType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to retrieve a list of inventory.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="CompatibilitySets_List" type="CompatibilitySet_ListType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to retrieve a list of compatibility sets.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="CompatibilitySets_AddUpdate" type="CompatibilitySet_AddUpdateType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to add or update compatibility sets.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Item_List" type="Item_ListType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to retrieve a list of items.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Item_AddUpdate" type="Item_AddUpdateType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to add or update items.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Order_List" type="Order_ListType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to retrieve a list of orders.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Order_Add" type="Order_AddUpdateType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to add orders.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Order_Update" type="Order_AddUpdateType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to update orders.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Shipment_List" type="Shipment_ListType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to retrieve a list of shipments.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Shipment_Add" type="Shipment_AddUpdateType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to add shipments.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Shipment_Update" type="Shipment_AddUpdateType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to update shipments.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Sale_List" type="Sale_ListType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to retrieve a list of sales.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Sale_Add" type="Sale_AddUpdateType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to add sales.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Sale_Update" type="Sale_AddUpdateType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>An API call to update sales.</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:sequence>
  </xs:complexType>
</xs:element>
See Also
SixBit API Schema

 

 


© 2022 All Rights Reserved.

Send comments on this topic.